<?php
/**
* 
* ShopWindow Toolset
* 
* Copyright (C) 2008 Digital Window Ltd.
* 
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*
*/


require_once('class.api_client.php');


/**
 * Encapsulate the corresponding API functionality
 *
 */
class api_query_list extends api_client
{
	var $iCategoryId = null;	// the category Id to which the merchants belong


	/**
	 * Gets the most popular queries for a category
	 *
	 * @copyright	DigitalWindow
	 * @author		Kostas Melas <kostas@digitalwindow.com>
	 *
	 * @param 	int 	 $oParams->iCategoryId
	 * @param 	bool	 $oParams->bUseGlobalList
	 * @return 	array	 array of Query objects
	 */
	function getQueryList($oParams)
	{
		# sanity check
		$this->iCategoryId = $oParams->iCategoryId > 0 ? intval($oParams->iCategoryId) : $this->iCategoryId;

		// SOAP params
		$aParams = array("iCategoryId" => $this->iCategoryId, "bUseGlobalList" => GLOBAL_QUERY_LIST);

		// make the SOAP call
		$oResponse = $this->call('getQueryList', $aParams);

		// array of query objects
		$aQueries = $this->oResponse->oQuery;

		$aRemoveQueries = unserialize(QUERY_LIST_POPS);

		// check not empty
		if ( !empty( $aQueries ) ) {
			foreach ($aQueries as $key => $oQuery) {
				// remove from array
				if ( in_array($oQuery->sQuery, $aRemoveQueries) ) {
					unset($aQueries[$key]);
				}
			}
		}

		return $aQueries;
	}

}

?>